xml/Microsoft.Azure.Documents.Client/ResourceResponse`1.xml

<Type Name="ResourceResponse<TResource>" FullName="Microsoft.Azure.Documents.Client.ResourceResponse<TResource>"> <TypeSignature Language="C#" Value="public class ResourceResponse<TResource> : Microsoft.Azure.Documents.Client.ResourceResponseBase, Microsoft.Azure.Documents.Client.IResourceResponse<TResource> where TResource : Resource, new()" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ResourceResponse`1<.ctor (class Microsoft.Azure.Documents.Resource) TResource> extends Microsoft.Azure.Documents.Client.ResourceResponseBase implements class Microsoft.Azure.Documents.Client.IResourceResponse`1<!TResource>, class Microsoft.Azure.Documents.Client.IResourceResponseBase" /> <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.ResourceResponse`1" /> <TypeSignature Language="VB.NET" Value="Public Class ResourceResponse(Of TResource)
Inherits ResourceResponseBase
Implements IResourceResponse(Of TResource)" /> <TypeSignature Language="F#" Value="type ResourceResponse<'Resource (requires 'Resource :> Resource and 'Resource : (new : unit -> 'Resource))> = class
 inherit ResourceResponseBase
 interface IResourceResponse<'Resource (requires 'Resource :> Resource and 'Resource : (new : unit -> 'Resource))>
 interface IResourceResponseBase" /> <AssemblyInfo> <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName> <AssemblyVersion>2.14.0.0</AssemblyVersion> <AssemblyVersion>2.14.1.0</AssemblyVersion> <AssemblyVersion>2.15.0.0</AssemblyVersion> <AssemblyVersion>2.16.0.0</AssemblyVersion> <AssemblyVersion>2.16.1.0</AssemblyVersion> <AssemblyVersion>2.16.2.0</AssemblyVersion> <AssemblyVersion>2.17.0.0</AssemblyVersion> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName> <AssemblyVersion>2.14.0.0</AssemblyVersion> <AssemblyVersion>2.14.1.0</AssemblyVersion> <AssemblyVersion>2.15.0.0</AssemblyVersion> <AssemblyVersion>2.16.0.0</AssemblyVersion> <AssemblyVersion>2.16.1.0</AssemblyVersion> <AssemblyVersion>2.16.2.0</AssemblyVersion> <AssemblyVersion>2.17.0.0</AssemblyVersion> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <TypeParameters> <TypeParameter Name="TResource"> <Constraints> <ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute> <BaseTypeName>Microsoft.Azure.Documents.Resource</BaseTypeName> </Constraints> </TypeParameter> </TypeParameters> <Base> <BaseTypeName>Microsoft.Azure.Documents.Client.ResourceResponseBase</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>Microsoft.Azure.Documents.Client.IResourceResponse<TResource></InterfaceName> </Interface> <Interface> <InterfaceName>Microsoft.Azure.Documents.Client.IResourceResponseBase</InterfaceName> </Interface> </Interfaces> <Docs> <typeparam name="TResource">the resource type.</typeparam> <summary> Represents the template class used by methods returning single objects in the Azure Cosmos DB service. </summary> <remarks> All responses from creates, reads, updates and deletes of Azure Cosmos DB resources return the response wrapped in a ResourceResponse object. This contains the metadata from the response headers from the Azure Cosmos DB call including the request units (RequestCharge), activity ID and quotas/usage of resources. </remarks> <altmember cref="P:Microsoft.Azure.Documents.Client.ResourceResponse`1.Resource" /> <altmember cref="T:Microsoft.Azure.Documents.Client.FeedResponse`1" /> <example> The following example extracts the request units consumed, activity ID and StatusCode from a CreateDocumentAsync call. <code language="c#"><![CDATA[ ResourceResponse<Document> response = await client.CreateDocumentAsync(collectionLink, document); Console.WriteLine(response.RequestCharge); Console.WriteLine(response.ActivityId); Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201 ]]></code></example> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ResourceResponse ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.ResourceResponse`1.#ctor" /> <MemberSignature Language="VB.NET" Value="Public Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Constructor exposed for mocking purposes for the Azure Cosmos DB service. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ResourceResponse (TResource resource);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(!TResource resource) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.ResourceResponse`1.#ctor(`0)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (resource As TResource)" /> <MemberSignature Language="F#" Value="new Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))> : 'Resource -> Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))>" Usage="new Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))> resource" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="resource" Type="TResource" /> </Parameters> <Docs> <param name="resource" /> <summary> Constructor exposed for mocking purposes for the Azure Cosmos DB service. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="op_Implicit"> <MemberSignature Language="C#" Value="public static implicit operator TResource (Microsoft.Azure.Documents.Client.ResourceResponse<TResource> source);" /> <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname !TResource op_Implicit(class Microsoft.Azure.Documents.Client.ResourceResponse`1<!TResource> source) cil managed" /> <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Client.ResourceResponse`1.op_Implicit(Microsoft.Azure.Documents.Client.ResourceResponse{`0})~`0" /> <MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (source As ResourceResponse(Of TResource)) As TResource" /> <MemberSignature Language="F#" Value="static member op_Implicit : Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))> -> 'Resource" Usage="Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))>.op_Implicit source" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>TResource</ReturnType> </ReturnValue> <Parameters> <Parameter Name="source" Type="Microsoft.Azure.Documents.Client.ResourceResponse<TResource>" /> </Parameters> <Docs> <param name="source">The ResourceResponse source.</param> <summary> Returns the resource in the response implicitly from the Azure Cosmos DB service. </summary> <returns>The resource object.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Resource"> <MemberSignature Language="C#" Value="public TResource Resource { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance !TResource Resource" /> <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Client.ResourceResponse`1.Resource" /> <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Resource As TResource" /> <MemberSignature Language="F#" Value="member this.Resource : 'Resource" Usage="Microsoft.Azure.Documents.Client.ResourceResponse<'Resource (requires 'Resource :> Microsoft.Azure.Documents.Resource and 'Resource : (new : unit -> 'Resource))>.Resource" /> <MemberType>Property</MemberType> <Implements> <InterfaceMember>P:Microsoft.Azure.Documents.Client.IResourceResponse`1.Resource</InterfaceMember> </Implements> <AssemblyInfo> <AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <AssemblyInfo> <AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName> <AssemblyVersion>2.18.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>TResource</ReturnType> </ReturnValue> <Docs> <summary> Gets the resource returned in the response from the Azure Cosmos DB service. </summary> <value> The resource returned in the response. </value> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Microsoft.Azure.Documents.Client/ResourceResponse`1.xml (62 lines of code) (raw):